.\" Manual Page for Berkely DB utils, created from upstream
.\" documentation by Thijs Kinkhorst <thijs@kinkhorst.com>.
.TH DB_CHECKPOINT 1 "28 January 2005"
.SH NAME
db_checkpoint \- Periodically checkpoint transactions
.SH SYNOPSIS
.B db_checkpoint
[-1Vv] [-h home] [-k kbytes] [-L file] [-P password] [-p min]
.SH DESCRIPTION
The db_checkpoint utility is a daemon process that monitors the database log,
and periodically calls DB_ENV->txn_checkpoint to checkpoint it.
.SH OPTIONS
.IP \fB\-1\fR
Checkpoint the log once, regardless of whether or not there has been
activity since the last checkpoint and then exit.
.IP \fB\-h\fR
Specify a home directory for the database environment; by
default, the current working directory is used.
.IP \fB\-k\fR
Checkpoint the database at least as often as every \fBkbytes\fR of log
file are written.
.IP \fB\-L\fR
Log the execution of the db_checkpoint utility to the specified file in the
following format, where \fI###\fR is the process ID, and the date
is the time the utility was started.
.sp
.TR 8
db_checkpoint: ### Wed Jun 15 01:23:45 EDT 1995
.sp
This file will be removed if the db_checkpoint utility exits gracefully.
.IP \fB\-P\fR
Specify an environment password.  Although Berkeley DB utilities overwrite
password strings as soon as possible, be aware there may be a window of
vulnerability on systems where unprivileged users can see command-line
arguments or where utilities are not able to overwrite the memory
containing the command-line arguments.
.IP \fB\-p\fR
Checkpoint the database at least every \fBmin\fR minutes if there has
been any activity since the last checkpoint.
.IP \fB\-V\fR
Write the library version number to the standard output, and exit.
.IP \fB\-v\fR
Write the time of each checkpoint attempt to the standard output.
.PP
At least one of the \fB-1\fR, \fB-k\fR, and \fB-p\fR options
must be specified.
.PP
The db_checkpoint utility uses a Berkeley DB environment (as described for the
\fB-h\fR option, the environment variable \fBDB_HOME\fR, or
because the utility was run in a directory containing a Berkeley DB
environment).  In order to avoid environment corruption when using a
Berkeley DB environment, db_checkpoint should always be given the chance to
detach from the environment and exit gracefully.  To cause db_checkpoint
to release all environment resources and exit cleanly, send it an
interrupt signal (SIGINT).
.PP
The db_checkpoint utility does not attempt to create the Berkeley DB
shared memory regions if they do not already exist.  The application
that creates the region should be started first, and once the region is
created, the db_checkpoint utility should be started.
.PP
The DB_ENV->txn_checkpoint method is the underlying method used by the
db_checkpoint utility. See the db_checkpoint utility source code for an
example of using DB_ENV->txn_checkpoint in a IEEE/ANSI Std 1003.1
(POSIX) environment.
.PP
The db_checkpoint utility exits 0 on success, and >0 if an error occurs.
.PP
.SH ENVIRONMENT
.IP \fBDB_HOME\fR
If the \fB-h\fR option is not specified and the environment variable
DB_HOME is set, it is used as the path of the database home, as described
in DB_ENV->open.
.SH AUTHORS
Sleepycat Software, Inc. This manual page was created based on
the HTML documentation for db_checkpoint from Sleepycat,
by Thijs Kinkhorst <thijs@kinkhorst.com>,
for the Debian system (but may be used by others).
